
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta charset="utf-8" />
    <title>Log &#8212; atomman 1.4.0 documentation</title>
    <link rel="stylesheet" href="_static/basic.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <script type="text/javascript" src="_static/language_data.js"></script>
    <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
    <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
    <script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"inlineMath": [["$", "$"], ["\\(", "\\)"]], "processEscapes": true, "ignoreClass": "document", "processClass": "math|output_area"}})</script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="NEBLog" href="atomman.lammps.NEBLog.html" />
    <link rel="prev" title="lammps" href="atomman.lammps.html" /> 
  </head><body>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="atomman.lammps.NEBLog.html" title="NEBLog"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="atomman.lammps.html" title="lammps"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">atomman 1.4.0 documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="atomman.html" >atomman package</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="atomman.lammps.html" accesskey="U">lammps</a> &#187;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="log">
<h1>Log<a class="headerlink" href="#log" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="atomman.lammps.Log">
<em class="property">class </em><code class="sig-prename descclassname">atomman.lammps.</code><code class="sig-name descname">Log</code><span class="sig-paren">(</span><em class="sig-param">log_info=None</em><span class="sig-paren">)</span><a class="headerlink" href="#atomman.lammps.Log" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Object for representing a LAMMPS log output</p>
<dl class="method">
<dt id="atomman.lammps.Log.flatten">
<code class="sig-name descname">flatten</code><span class="sig-paren">(</span><em class="sig-param">style='last'</em><span class="sig-paren">)</span><a class="headerlink" href="#atomman.lammps.Log.flatten" title="Permalink to this definition">¶</a></dt>
<dd><p>Combines all simulations into one.  The style options allow for
duplicate timesteps to be overwritten.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>style</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a><em>, </em><em>optional</em>) – Specifies which values to use for duplicate time steps:
‘first’ uses the values from the earliest simulation.
‘last’ uses the values from the latest simulation (default).
‘all’ uses all reported lines including ones with duplicate time
steps.</p>
</dd>
</dl>
</dd></dl>

<dl class="method">
<dt id="atomman.lammps.Log.lammps_date">
<em class="property">property </em><code class="sig-name descname">lammps_date</code><a class="headerlink" href="#atomman.lammps.Log.lammps_date" title="Permalink to this definition">¶</a></dt>
<dd><p>The date associated with the LAMMPS version used.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.date" title="(in Python v3.9)">datetime.date</a></p>
</dd>
</dl>
</dd></dl>

<dl class="method">
<dt id="atomman.lammps.Log.lammps_version">
<em class="property">property </em><code class="sig-name descname">lammps_version</code><a class="headerlink" href="#atomman.lammps.Log.lammps_version" title="Permalink to this definition">¶</a></dt>
<dd><p>The LAMMPS version used.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></p>
</dd>
</dl>
</dd></dl>

<dl class="method">
<dt id="atomman.lammps.Log.read">
<code class="sig-name descname">read</code><span class="sig-paren">(</span><em class="sig-param">log_info</em>, <em class="sig-param">append=True</em><span class="sig-paren">)</span><a class="headerlink" href="#atomman.lammps.Log.read" title="Permalink to this definition">¶</a></dt>
<dd><p>Parses a LAMMPS screen output/log file.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>log_info</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a><em> or </em><em>file-like object</em>) – The LAMMPS log content to read in.</p></li>
<li><p><strong>append</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.9)"><em>bool</em></a><em>, </em><em>optional</em>) – Flag indicating if the content being read in is appended to the
current data (True, default), or if it overwrites any existing
saved content (False).</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="method">
<dt id="atomman.lammps.Log.simulations">
<em class="property">property </em><code class="sig-name descname">simulations</code><a class="headerlink" href="#atomman.lammps.Log.simulations" title="Permalink to this definition">¶</a></dt>
<dd><p>parsed data for each separate LAMMPS run/minimize action</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>list of dict</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h4>Previous topic</h4>
  <p class="topless"><a href="atomman.lammps.html"
                        title="previous chapter">lammps</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="atomman.lammps.NEBLog.html"
                        title="next chapter">NEBLog</a></p>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="atomman.lammps.NEBLog.html" title="NEBLog"
             >next</a> |</li>
        <li class="right" >
          <a href="atomman.lammps.html" title="lammps"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">atomman 1.4.0 documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="atomman.html" >atomman package</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="atomman.lammps.html" >lammps</a> &#187;</li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.2.0.
    </div>
  </body>
</html>